Skip to content

Create header mode to enable eliding function / method bodies #5516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 9 commits into from
Closed

Create header mode to enable eliding function / method bodies #5516

wants to merge 9 commits into from
+468 −48

Conversation

@aviroop-123
Copy link
Contributor

@aviroop-123 aviroop-123 commented Oct 1, 2025

  • Create -Xheader-mode compiler argument to enable header generation.
  • Skip converting function and method body code to FIR.
  • Skip inline functions, objects and functions.
  • Handle null body during FIR -> IR conversion.
  • Handle contracts.
  • Disable checkers during header compilation.

More in https://youtrack.jetbrains.com/issue/KT-78422

@aviroop-123 aviroop-123 requested review from a team as code owners October 1, 2025 23:05
@aviroop-123 aviroop-123 force-pushed the header-compilation-1 branch from d2bc6f9 to 1078988 Compare October 2, 2025 01:51
@ddolovov
Copy link
Contributor

ddolovov commented Oct 2, 2025 •
edited
Loading

Is this a Kotlin/JVM-only feature?

If yes, then why the CLI flag is available for other Kotlin compilers?

If no, then what's the plan towards the exising -Xheader-klib-path CLI flag in Kotlin/Native?

@aviroop-123
Copy link
Contributor Author

aviroop-123 commented Oct 2, 2025

Is this a Kotlin/JVM-only feature? If yes, then why the CLI flag is available for other Kotlin compilers? If no, then what's the plan towards the exising -Xheader-klib-path CLI flag in Kotlin/Native?

No, we should change the description of the issue. It should work atleast across the JVM and native compiler. Once all the features are implemented, we might be able to deprecate the Xheader-klib-path.

@ddolovov
Copy link
Contributor

ddolovov commented Oct 2, 2025

I think, it's also important to pass the "header mode" flag down to IrSerializationSettings.publicAbiOnly. This way you can instruct the IR serializer to avoid serializing data that is not part of KLIB ABI, for example, IR element offsets.

@aviroop-123 aviroop-123 requested a review from a team as a code owner October 4, 2025 04:21
@aviroop-123 aviroop-123 force-pushed the header-compilation-1 branch 2 times, most recently from e6c6a4e to e4690f2 Compare October 6, 2025 04:04
@mglukhikh
Copy link
Contributor

mglukhikh commented Oct 6, 2025

I don't see any tests for the feature and it seems quite strange for me. As a very minimum, I'd recommend to add some new tests to compiler/fir/analysis-tests/testData/resolve with the new flag enabled and FIR_DUMP also enabled. This will allow you to check if the necessary body parts (like contracts) are generated and unnecessary parts are not generated.

@aviroop-123 aviroop-123 force-pushed the header-compilation-1 branch 2 times, most recently from 0916a66 to f02fb2d Compare October 14, 2025 17:26
@mglukhikh
Copy link
Contributor

mglukhikh commented Oct 23, 2025

Partially merged (discussed internally).

@mglukhikh mglukhikh closed this Oct 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mglukhikh mglukhikh mglukhikh left review comments

@ddolovov ddolovov ddolovov left review comments

@sbogolepov sbogolepov Awaiting requested review from sbogolepov sbogolepov is a code owner automatically assigned from JetBrains/kotlin-native

@JSMonk JSMonk Awaiting requested review from JSMonk JSMonk is a code owner automatically assigned from JetBrains/kotlin-js

@igoriakovlev igoriakovlev Awaiting requested review from igoriakovlev igoriakovlev is a code owner automatically assigned from JetBrains/kotlin-wasm

@ALikhachev ALikhachev Awaiting requested review from ALikhachev ALikhachev is a code owner automatically assigned from JetBrains/kotlin-build-tools

@grechkovlad grechkovlad Awaiting requested review from grechkovlad grechkovlad is a code owner automatically assigned from JetBrains/kotlin-jvm

Assignees

@udalov udalov

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aviroop-123 @ddolovov @mglukhikh @udalov